<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class TTpObj</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class TTpObj</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Base class for TurboPhp objects that can be managed by <a href="../TurboPhpLib/TTpApp.html">TTpApp</a>.</p>
<p class="description"><p>Each TTpObj represents an HTML element in the parsed template.</p></p>
		<p class="notes">
			Located in <a class="field" href="_TpLib_php.html">/TpLib.php</a> (line <span class="field"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a757">757</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../TurboPhpLib/TTpDbText.html">TTpDbText</a></td>
					<td>
											Label whose contents are obtained from a data source.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../TurboPhpLib/TTpSilentObj.html">TTpSilentObj</a></td>
					<td>
											TTpObj subclass that generates no output.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../TurboPhpLib/TTpControl.html">TTpControl</a></td>
					<td>
											An object that has the ability to search the input request.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../TurboPhpLib/TTpSheet.html">TTpSheet</a></td>
					<td>
											A single sheet inside a <a href="../TurboPhpLib/TTpPageControl.html">TTpPageControl</a>.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../TurboPhpLib/TTpPageControl.html">TTpPageControl</a></td>
					<td>
											A control that can display one of several overlapping blocks of content.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../TurboPhpLib/TTpFmtLabel.html">TTpFmtLabel</a></td>
					<td>
											Base class for TurboPhp objects that can be managed by <a href="../TurboPhpLib/TTpApp.html">TTpApp</a>.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../TurboPhpLib/TTpSizeLabel.html">TTpSizeLabel</a></td>
					<td>
											Base class for TurboPhp objects that can be managed by <a href="../TurboPhpLib/TTpApp.html">TTpApp</a>.
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
								<div class="var-title">
					<span class="var-type"><a href="../TurboPhpLib/TTpApp.html">TTpApp</a></span>
					<a href="#$App" title="details" class="var-name">$App</a>
				</div>
								<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$Attributes" title="details" class="var-name">$Attributes</a>
				</div>
								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$Content" title="details" class="var-name">$Content</a>
				</div>
								<div class="var-title">
					<span class="var-type">boolean</span>
					<a href="#$DebugFlag" title="details" class="var-name">$DebugFlag</a>
				</div>
								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$Elt" title="details" class="var-name">$Elt</a>
				</div>
								<div class="var-title">
					<span class="var-type">boolean</span>
					<a href="#$Hidden" title="details" class="var-name">$Hidden</a>
				</div>
								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$Name" title="details" class="var-name">$Name</a>
				</div>
								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$OnGenerate" title="details" class="var-name">$OnGenerate</a>
				</div>
								<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$Styles" title="details" class="var-name">$Styles</a>
				</div>
							</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">TTpObj</span>
										<a href="#TTpObj" title="details" class="method-name">TTpObj</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#Assign" title="details" class="method-name">Assign</a>
											(<span class="var-type"><a href="../TurboPhpLib/TTpObj.html">TTpObj</a></span>&nbsp;<span class="var-name">&$inObj</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#Debug" title="details" class="method-name">Debug</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$inMsg</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$inFullTrace</span> = <span class="var-default">false</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#Dump" title="details" class="method-name">Dump</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#GetDefaultValue" title="details" class="method-name">GetDefaultValue</a>
										()
									</div>
							</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$App" id="$App"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../TurboPhpLib/TTpApp.html">TTpApp</a></span>
			<span class="var-name">$App</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a763">763</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reference to the owning <a href="../TurboPhpLib/TTpApp.html">TTpApp</a> object.</p>
	
	
		
		

</div>
<a name="var$Attributes" id="$Attributes"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$Attributes</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a807">807</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Array of HTML attributes (name/value pairs).</p>
<p class="description"><p>Attributes are encoded using XHTML standards (i.e. attribute names  are all lowercase).</p><p>Change attributes by setting array values, e.g.,  <pre><ol><code><pre><li><span class="src-id"><a href="../TurboPhpLib/TTpObj.html#var$Attributes">Attributes</a></span><span class="src-sym">[</span><span class="src-str">'bgcolor'</span><span class="src-sym">] </span>= <span class="src-str">'green'</span><span class="src-sym">;</span></li>
</pre></code></ol></pre>  Clear an attribute by  <pre><ol><code><pre><li><span class="src-id"><a href="../TurboPhpLib/TTpObj.html#var$Attributes">Attributes</a></span><span class="src-sym">[</span><span class="src-str">'bgcolor'</span><span class="src-sym">] </span>= <span class="src-str">''</span><span class="src-sym">;</span></li>
</pre></code></ol></pre>  or  <pre><ol><code><pre><li>unset<span class="src-sym">(</span><span class="src-var">$object</span><span class="src-sym">-&gt;</span><span class="src-id"><a href="../TurboPhpLib/TTpObj.html#var$Attributes">Attributes</a></span><span class="src-sym">[</span><span class="src-str">'bgcolor'</span><span class="src-sym">]</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</pre></code></ol></pre>  Attributes that don't have values should be encoded XHTML style, e.g.  <pre><ol><code><pre><li><span class="src-id"><a href="../TurboPhpLib/TTpObj.html#var$Attributes">Attributes</a></span><span class="src-sym">[</span><span class="src-str">'readonly'</span><span class="src-sym">] </span>= <span class="src-str">'readonly'</span></li>
</pre></code></ol></pre>  <strong>Note</strong>: avoid setting the <em>style</em> attribute using Attributes  array. Instead, put style entities into the <a href="../TurboPhpLib/TTpObj.html#var$Styles">Styles</a> array.</p></p>
	
	
		
		

</div>
<a name="var$Content" id="$Content"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$Content</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a831">831</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The content of the HTML tag.</p>
<p class="description"><p>Holds the text that will be output between  the element tags: <em>&lt;tag&gt;&lt;b&gt;content&lt;/b&gt;&lt;/tag&gt;</em></p></p>
	
	
		
		

</div>
<a name="var$DebugFlag" id="$DebugFlag"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$DebugFlag</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a782">782</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enable debugging output.</p>
<p class="description"><p>If false, debugging output is suppressed for this object.</p></p>
	
	
		
		

</div>
<a name="var$Elt" id="$Elt"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$Elt</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a789">789</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Element for this control's HTML tag.</p>
<p class="description"><p>Every TTpObject corresponds to an HTML tag  (e.g. td, div, input, etc.).  $Elt contains the tag element.</p></p>
	
	
		
		

</div>
<a name="var$Hidden" id="$Hidden"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$Hidden</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a843">843</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">True to hide the object.</p>
<p class="description"><p>If true, this object's HTML is not written  to the output.</p></p>
	
	
		
		

</div>
<a name="var$Name" id="$Name"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$Name</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a768">768</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Name of this object.</p>
	
	
		
		

</div>
<a name="var$OnGenerate" id="$OnGenerate"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$OnGenerate</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a853">853</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Name of OnGenerate event function.</p>
<p class="description"><p>This event is fired from Generate before output  is generated for this object.  This event may be fired multiple times if the object is used more than  once in the page. For example, a label object in a <a href="../TurboPhpLib/TTpRepeater.html">TTpRepeater</a>  will be generated once for each repeat.</p></p>
	
	
		
		

</div>
<a name="var$Styles" id="$Styles"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$Styles</span>
						(line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a824">824</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Array of style attributes (name/value pairs).</p>
<p class="description"><p>Change attributes by setting array values, e.g.,  <pre><ol><code><pre><li><span class="src-id"><a href="../TurboPhpLib/TTpObj.html#var$Styles">Styles</a></span><span class="src-sym">[</span><span class="src-str">'background-color'</span><span class="src-sym">] </span>= <span class="src-str">'green'</span><span class="src-sym">;</span></li>
</pre></code></ol></pre>  Clear an attribute by  <pre><ol><code><pre><li><span class="src-id"><a href="../TurboPhpLib/TTpObj.html#var$Styles">Styles</a></span><span class="src-sym">[</span><span class="src-str">'background-color'</span><span class="src-sym">] </span>= <span class="src-str">''</span><span class="src-sym">;</span></li>
</pre></code></ol></pre>  or  <pre><ol><code><pre><li>unset<span class="src-sym">(</span><span class="src-var">$object</span><span class="src-sym">-&gt;</span><span class="src-id"><a href="../TurboPhpLib/TTpObj.html#var$Styles">Styles</a></span><span class="src-sym">[</span><span class="src-str">'background-color'</span><span class="src-sym">]</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</pre></code></ol></pre></p></p>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodTTpObj" id="TTpObj"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor TTpObj</span> (line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a861">861</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Calls the Init method.</p>
<p class="description"><p>Subclasses generally perform initialization  duties in an overriden Init method instead of in constructors  to avoid object referencing problems.</p></p>
	
	<div class="method-signature">
		<span class="method-result">TTpObj</span>
		<span class="method-name">
			TTpObj
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodAssign" id="Assign"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Assign</span> (line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a883">883</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Assign the attributes of <var>$inObj</var> to this object.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			Assign
		</span>
					(<span class="var-type"><a href="../TurboPhpLib/TTpObj.html">TTpObj</a></span>&nbsp;<span class="var-name">&$inObj</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../TurboPhpLib/TTpObj.html">TTpObj</a></span>
				<span class="var-name">&$inObj</span><span class="var-description">: Reference to object whose attributes are to be copied.</span>			</li>
				</ul>
		
		
	</div>
<a name="methodDebug" id="Debug"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Debug</span> (line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a912">912</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Output a single line message to the debugging console.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			Debug
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$inMsg</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$inFullTrace</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$inMsg</span><span class="var-description">: Message to output.</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$inFullTrace</span><span class="var-description">: True to prepend a full stack trace to the debug output.  Otherwise only the calling function is identified.</span>			</li>
				</ul>
		
		
	</div>
<a name="methodDump" id="Dump"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Dump</span> (line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a1237">1237</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Dump object information to the standard output.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			Dump
		</span>
				()
			</div>
	
		
		
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../TurboPhpLib/TTpDbText.html#methodDump">TTpDbText::Dump()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpDbConnect.html#methodDump">TTpDbConnect::Dump()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpQuery.html#methodDump">TTpQuery::Dump()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpFileList.html#methodDump">TTpFileList::Dump()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpWebVariable.html#methodDump">TTpWebVariable::Dump()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpInput.html#methodDump">TTpInput::Dump()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpDbInput.html#methodDump">TTpDbInput::Dump()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpClickable.html#methodDump">TTpClickable::Dump()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpSelect.html#methodDump">TTpSelect::Dump()</a>
							</li>
				</ul>
	</div>
<a name="methodGetDefaultValue" id="GetDefaultValue"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetDefaultValue</span> (line <span class="line-number"><a href="..//__filesource/fsource_TurboPhpLib__TpLib.php.html#a1103">1103</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get whatever data is considered the <em>value</em> of this object.</p>
<p class="description"><p>For TTpObj, this method returns the object's <a href="../TurboPhpLib/TTpObj.html#var$Content">Content</a>.  Subclasses may override to return other data.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> default value of this control.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			GetDefaultValue
		</span>
				()
			</div>
	
		
		
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../TurboPhpLib/TTpWebVariable.html#methodGetDefaultValue">TTpWebVariable::GetDefaultValue()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpInput.html#methodGetDefaultValue">TTpInput::GetDefaultValue()</a>
							</li>
					<li>
				<a href="../TurboPhpLib/TTpTextArea.html#methodGetDefaultValue">TTpTextArea::GetDefaultValue()</a>
							</li>
				</ul>
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 12 Nov 2004 16:34:03 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>